API Documentation
Image.h
1 // Image.h
3 //
5 
6 namespace nkImages
7 {
13  class Image final : public ImageBase
14  {
15  public :
16 
20  Image () ;
35  Image (nkMemory::Buffer&& data, unsigned int width, unsigned int height, PIXEL_FORMAT format) ;
47  Image (nkMemory::Buffer&& data, unsigned int width, unsigned int height, unsigned int depth, PIXEL_FORMAT format, unsigned int pixelByteSize, unsigned int rowByteSize) ;
54  Image (const Image& other) ;
61  Image (Image&& other) ;
65  ~Image () ;
66 
67  // Data access
71  virtual unsigned char* getDataPtr () const override ;
75  const nkMemory::Buffer& getData () const ;
76 
77  // Operators
83  Image& operator= (const Image& other) ;
89  Image& operator= (Image&& other) ;
90  } ;
91 }
nkImages::Image::Image
Image(nkMemory::Buffer &&data)
nkImages::Image::operator=
Image & operator=(const Image &other)
nkImages::Image::Image
Image(nkMemory::Buffer &&data, unsigned int width, unsigned int height, unsigned int depth, PIXEL_FORMAT format, unsigned int pixelByteSize, unsigned int rowByteSize)
nkImages::Image::getData
const nkMemory::Buffer & getData() const
nkMemory::Buffer
A buffer holding binary data.
Definition: Buffer.h:32
nkImages::Image::~Image
~Image()
nkImages::ImageBase
Base for all image data classes.
Definition: ImageBase.h:19
nkImages
Encompasses all API of component NilkinsImages.
Definition: BmpEncoder.h:7
nkImages::Image::Image
Image()
nkImages::Image::Image
Image(Image &&other)
nkImages::PIXEL_FORMAT
PIXEL_FORMAT
Lists formats for pixels.
Definition: PixelFormat.h:16
nkImages::Image::Image
Image(const Image &other)
nkImages::Image::getDataPtr
virtual unsigned char * getDataPtr() const override
nkImages::Image
Holds all information required for an image, with ownership over the data.
Definition: Image.h:14
nkImages::Image::Image
Image(nkMemory::Buffer &&data, unsigned int width, unsigned int height, PIXEL_FORMAT format)